Azure Maps Map Configuration Service (stable:2023-07-01)

2025/10/06 • 5 deleted methods

MapConfiguration_Create (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The Map Configuration Create request allows the caller to create a map configuration in their Azure Maps account. Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. ## Submit Create Request To create your map configuration you will make a `POST` request with a map configuration file. ### POST Body for Create Request An `HTTP POST` request with the map configuration data in the body of the request is required to create a new map configuration in your Azure Maps account. The map configuration data must be in JSON format with `Content-Type` set to `application/json` in the header. Alternatively, you can send the map configuration JSON in a ZIP file along with any thumbnail images it references, with `Content-Type` set to `application/zip` in the header. Note: The embedded JSON size limit is 1 MB and zip file size limit is 23 MB. Here's a sample map configuration json: ```json { "version": 1.0, "description": "First indoor map configuration!", "defaultConfiguration": "indoor_light", "configurations": [ { "name": "indoor_light", "displayName": "Indoor light", "theme": "light", "thumbnail": "indoor_2022-01-01.png", "baseMap": "microsoft_light", "layers": [ { "tilesetId": "9601b149-cff6-dae6-af94-396f1b795fdb", "styleId": "microsoft-maps:indoor_2022-01-01" } ] }, { "name": "indoor_dark", "displayName": "Indoor dark", "theme": "dark", "baseMap": "microsoft_dark", "thumbnail": "indoor_dark_2022-01-01.png", "layers": [ { "tilesetId": "9601b149-cff6-dae6-af94-396f1b795fdb", "styleId": "microsoft-maps:indoor_dark_2022-01-01" } ] } ] } ``` Since the map configuration json contains two thumbnail image references 'indoor_2022-01-01.png' and 'indoor_dark_2022-01-01.png', a zip file including the map configuration json file and two thumbnail images should be provided as request body to make a valid create request. The Create Map Configuration API is a [long-running operation](https://aka.ms/am-creator-lrt-v2).
Reference :  Link ¶

⚼ Request

POST:  /styles/mapconfigurations
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
alias:
{
Description: The alias of the map configuration. Maximum length 1024 characters. Alias cannot start with `microsoft-maps` which is a reserved prefix. Alias can be provided optionally during creating a map configuration, and can be used as same as mapConfigurationId after map configuration creation. ,
Required: False ,
}
string ,
description:
{
Description: User provided description of the map configuration. Maximum length 1024 characters. ,
Required: False ,
}
string ,
MapConfiguration:
{
Description: The configuration file used to create the map configuration. If JSON data format is provided, then the request body should follow [MapConfiguration specification](/rest/api/documentation-preview/map-configuration/create?#mapconfiguration). If ZIP data format is provided, you should also provide the thumbnail images referenced in the configuration JSON file. ,
Required: True ,
}
{
version:
{
Description: The version of the map configuration, currently only version 1.0 is supported. ,
Format: float ,
Required: True ,
}
number ,
description:
{
Description: The description the caller provided when creating the map configuration. Maximum length 1024 characters. ,
Required: False ,
}
string ,
defaultConfiguration:
{
Description: The default configuration for the map configuration. The value should be one of the 'name' field in ConfigurationObject under 'configurations' array. If not provided, first entry in the 'configurations' list will be used. ,
Required: False ,
}
string ,
configurations:
{
Description: 'Configurations' array will allow customer to configure different map representations for their tileset. Each configuration configured here will be reflected as one map style in style picker in client SDK. The name should be unique in the configurations array. ,
Required: False ,
}
[
{
name:
{
Description: The name for the style. Maximum length 255 characters. ,
Required: True ,
}
string ,
displayName:
{
Description: The display name for the style picker in client SDK. Maximum length 255 characters. ,
Required: False ,
}
string ,
description:
{
Description: The description for the style. Maximum length 500 characters. ,
Required: False ,
}
string ,
theme:
{
Description: The theme for client SDK widgets(style picker, zoom, level picker). ,
Enum:
{
light: The light theme for client SDK widgets(style picker, zoom, level picker). ,
dark: The dark theme for client SDK widgets(style picker, zoom, level picker). ,
}
,
Required: False ,
}
enum ,
thumbnail:
{
Description: The thumbnail image file for the style picker in client SDK. Maximum length 255 characters. The size limit is 400KB and pixel limit is 512*512. ,
Required: False ,
}
string ,
baseMap:
{
Description: The base map is a background layer for private indoor map. This property is optional, no base map will show if not provided. Maximum length 100 characters. ,
Enum:
{
microsoft_light: The base road map style. ,
microsoft_dark: The base dark road map style. ,
microsoft_grayscale_light: The grayscale light map style. ,
microsoft_grayscale_dark: The grayscale dark map style. ,
microsoft_high_contrast_light: The high contrast light map style. ,
microsoft_high_contrast_dark: The high contrast dark map style. ,
microsoft_shaded_relief: The shaded relief map style. ,
microsoft_satellite: The satellite imagery map style. ,
microsoft_satellite_road: The satellite and road map style. ,
}
,
Required: False ,
}
enum ,
layers:
{
Description: To configure the style for tileset. You can have one style for the whole tileset. And you can have different styles for different layers in one tileset, for example, one style for `indoor unit` layer and another style for `indoor facility` layer. And you have also have one style for different tileset ,
Required: True ,
}
[
{
tilesetId:
{
Description: The unique id of a tileset. ,
Required: True ,
}
string ,
styleId:
{
Description: The unique id of an azure map style. Two predefined styleId aliases are `microsoft-maps:indoor_2022-01-01` for indoor light and `microsoft-maps:indoor_dark_2022-01-01` for indoor dark. ,
Required: True ,
}
string ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{
operation-location:
{
Description: New URL to check for the results of the long-running operation. ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MapConfiguration_List (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The Map Configuration List request allows the caller to fetch a list of all map configurations created. You will see all the default map configurations which are created during tileset creation. Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.
Reference :  Link ¶

⚼ Request

GET:  /styles/mapconfigurations
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
mapConfigurations:
{
Description: A list of all map configurations. ,
Required: False ,
}
[
{
mapConfigurationId:
{
Description: The unique id for the map configuration. ,
Required: False ,
}
string ,
description:
{
Description: The description the caller provided when creating the map configuration. Maximum length 1024 characters. ,
Required: False ,
}
string ,
alias:
{
Description: The alias used for the map configuration. Maximum length 1024 characters. Alias cannot start with `microsoft-maps` which is a reserved prefix. ,
Required: False ,
}
string ,
created:
{
Description: The creation date and time of this map configuration. As defined by `date-time` - [RFC3339](https://xml2rfc.tools.ietf.org/public/rfc/html/rfc3339.html#anchor14) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: If present, the location of the next page of data. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MapConfiguration_Get (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The Map Configuration Get request allows the caller to fetch a map configuration. The response contains a zip file with the map configuration JSON and any image files it references. You can always get the default map configuration using predefined alias `defaultIndoor_{tilesetId}` for a given tileset if you deleted the auto-generated map configuration. The two predefined styles used in default map configuration are `microsoft-maps:indoor_2022-01-01` and `microsoft-maps:indoor_dark_2022-01-01`. Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator.
Reference :  Link ¶

⚼ Request

GET:  /styles/mapconfigurations/{mapConfigurationId}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
mapConfigurationId:
{
Description: The map configuration Id. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
content-type:
{
Description: The content-type for the response. ,
}
string ,
}
,
$schema:
{
Format: file ,
}
object ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MapConfiguration_Delete (removed)
Description :  **Applies to:** see pricing [tiers](https://aka.ms/AzureMapsPricingTier). The Map Configuration Delete request allows the caller to remove a map configuration from their Azure Maps account. You can use this API if a map configuration is no longer needed. Creator makes it possible to develop applications based on your private indoor map data using Azure Maps API and SDK. [This](https://docs.microsoft.com/azure/azure-maps/creator-indoor-maps) article introduces concepts and tools that apply to Azure Maps Creator. ### Submit Delete Request An `HTTP DELETE` request with the `mapConfigurationId` in the path of the request is required to remove an existing map configuration from your Azure Maps account.
#### Delete request "Successful" The Map Configuration Delete API returns a HTTP `204 No Content` response with an empty body, if the map configuration was deleted successfully.
#### Delete request "Failed" A HTTP `400 Bad Request` error response will be returned if the map configuration with the passed-in `mapConfigurationId` is not found. Here is a sample error response:
```json { "error": { "code": "400 BadRequest", "message": "Bad request - MapConfiguration Id: d85b5b27-5fc4-4599-8b50-47160e90f8ce does not exist." } } ```
Reference :  Link ¶

⚼ Request

DELETE:  /styles/mapconfigurations/{mapConfigurationId}
{
x-ms-client-id:
{
Description: Indicates the account intended for use with the Microsoft Entra ID security model. This unique ID for the Azure Maps account can be obtained from the [Azure Maps management plane Account API](/rest/api/maps-management/accounts). For more information on using Microsoft Entra ID security in Azure Maps, see [Manage authentication in Azure Maps](/azure/azure-maps/how-to-manage-authentication). ,
Required: False ,
}
string ,
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
mapConfigurationId:
{
Description: The map configuration Id. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MapConfiguration_GetOperation (removed)
Description :  The Map Configuration Get Operation request is obtained from the call to create a map configuration. It is returned in the response headers Resource-Location key once the creation process has completed successfully.
Reference :  Link ¶

⚼ Request

GET:  /styles/mapconfigurations/operations/{operationId}
{
api-version:
{
Description: Version number of Azure Maps API. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID to query the status for the map configuration create request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
resource-location:
{
Description: If successful, a URI where details on the newly created resource can be found. ,
}
string ,
}
,
$schema:
{
Description: The response model for a Long-Running Operations API. ,
}
{
operationId:
{
Description: The Id for this long-running operation. ,
Required: False ,
}
string ,
status:
{
Description: The status state of the request. ,
Enum:
{
NotStarted: The request has not started processing yet. ,
Running: The request has started processing. ,
Failed: The request has one or more failures. ,
Succeeded: The request has successfully completed. ,
}
,
Required: False ,
}
enum ,
created:
{
Description: The created timestamp. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
warning:
{
Description: The error detail. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}